|
|
PrimeTime |
||||
| Header: | Timer.h | Carbon status: | Supported | |
Activates a task in the Time Manager queue.
void PrimeTime (
QElemPtr tmTaskPtr,
SInt32 count
);
A pointer to a task structure already installed in the queue.
The desired delay before execution of the task.
The PrimeTime function schedules the task specified by the tmAddr field of tmTaskPtr for execution after the delay specified by the count parameter has elapsed.
If the count parameter is a positive value, it is interpreted as milliseconds. If count is a negative value, it is interpreted in negated microseconds. (Microsecond delays are allowable only in the revised and extended Time Managers.)
The task structure specified by tmTaskPtr must already be installed in the queue (by a previous call to InsTime or InsXTime) before your application calls PrimeTime. PrimeTime returns immediately, and the specified task is executed after the specified delay has elapsed. If you call PrimeTime with a time delay of 0, the task runs as soon as interrupts are enabled.
In the revised and extended Time Managers, PrimeTime sets the high-order bit of the qType field to 1. In addition, any value of the count parameter that exceeds the maximum millisecond delay is reduced to the maximum. If you stop an unexpired task (by calling RmvTime) and then reinstall it (by calling InsXTime), you can continue the previous delay by calling PrimeTime with the count parameter set to 0.
Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.
© 2000 Apple Computer, Inc. (Last Updated 6/30/2000)